package com.framework.log.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * 日志记录注解，用于标记需要进行日志记录的方法。
 * 
 * <p>该注解可以应用在方法级别，用于自动记录方法的调用日志。
 * 使用示例：
 * <pre>
 *     {@code @Log("执行用户查询")}
 *     public User getUser(Long id) {
 *         // 方法实现
 *     }
 * </pre>
 * </p>
 *
 * @author zzg
 * @since 1.0
 */
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Log {
	/**
	 * 日志描述信息
	 *
	 * @return 要记录的日志描述，如果不指定则返回空字符串
	 */
	String value() default "";
}
